home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1998 #4 / Amiga Plus CD - 1998 - No. 4.iso / pd / disk / fback-dist / doc / fmirr14c.doc < prev    next >
Text File  |  1998-02-22  |  11KB  |  303 lines
  1.  
  2.   *********************************************************************
  3.                               FMirror  V1.4c
  4.                             By Chris De Maeyer
  5.                              For AmigaDOS 68k
  6.   *********************************************************************
  7.  
  8.  
  9.   0. Contents
  10.     ----------
  11.  
  12.      1. Introduction
  13.         1.1. Legal
  14.         1.2. What it does...
  15.         1.3. Requirements
  16.         1.4. Contact address
  17.         1.5. Development info
  18.         1.6. Versions
  19.  
  20.      2. Using it
  21.         2.1. Command line options
  22.         2.2. Examples
  23.  
  24.      3. Appendix
  25.         3.1. Common problems
  26.         3.2. Error messages
  27.         3.3. The future
  28.  
  29.  
  30.   1. Introduction
  31.     --------------
  32.  
  33.      1.1. Legal
  34.          -------
  35.           Type  : - (E)MAILWARE
  36.           Terms : - no modifications to any file in this archive
  37.                   - add no additional files to this archive
  38.                   - use this program >30 days, then you should
  39.                     reward the author with a postcard/letter, hence the term
  40.                     mailware
  41.                   - author can not be held responsible for data loss, the program
  42.                     has been tested and the behaviour has been described below.
  43.  
  44.  
  45.      1.2. What it does
  46.          --------------
  47.           'FMirror' is a file deletion tool. It will check the files in its source
  48.           path with the destination path and delete the files in source path not
  49.           found in destination path. Comprendo !?!
  50.           
  51.           Example: when running 'FBack' create a mirror.
  52.  
  53.           You can run the program in CLI mode or GUI mode. CLI mode will perform
  54.           better speedwise. 
  55.           
  56.           In GUI mode, the window will remain open until you click the close
  57.           gadget. Unless you specify NOWAIT, then it closes when processing has
  58.           finished.
  59.  
  60.           Includes the batch mode, it uses the same configuration file as "FBack".
  61.           
  62.           New in this version: CLI mode can be interrupted, empty directories on
  63.           the backup are removed.
  64.  
  65.           
  66.  
  67.      1.3. Requirements
  68.          --------------
  69.           Nothing special is needed (except from a properly installed Amiga V38+).
  70.  
  71.  
  72.      1.4. Contact address
  73.          -----------------
  74.           For information/problems/gifts/bugs etc. write to the address
  75.           below, state version & add postage for reply:
  76.  
  77.                   Visionary Software
  78.                   tav. Chris De Maeyer
  79.  
  80.                   Norbertijnenstraat 4
  81.                   B-2040       BELGIUM
  82.                   EUROPE
  83.  
  84.                   Internet :cdemaeyer1@mmm.com
  85.                   Alternate:ceppe@geocities.com
  86.                   Homepage :http://www.geocities.com/siliconvalley/peaks/8452 
  87.                                  
  88.                                  
  89.      1.5. Development info
  90.          ------------------
  91.           Sources were written in C and compiled using SAS/C V6.58.
  92.  
  93.           All file I/O has been coded using standard system library
  94.           functions (V38+).
  95.  
  96.  
  97.      1.6. Versions
  98.          ----------
  99.           The actual version can always be determined by typing 'version
  100.           fmirror' in a CLI window.
  101.           It is recommended to always upgrade to the latest version.
  102.                     
  103.           V0.9  - first test version.
  104.  
  105.           V1.0  FIRST RELEASE
  106.                 - first public release.
  107.           
  108.           V1.2b MINOR UPDATE 
  109.                 - changed some internal values
  110.                 - changed some messages
  111.                 - included program with "FBack" archive
  112.                 - bumped version number to 1.2b.
  113.                  
  114.           V1.2c MINOR UPDATE
  115.                 - fixed pattern matching.       
  116.  
  117.           V1.3  MAJOR UPDATE
  118.                 - cleanup the code
  119.                 - added GUI option
  120.                 - added NOWAIT option.
  121.  
  122.           V1.3a MINOR UPDATE
  123.                 - bumped version with code generation SAS/C 6.58.
  124.  
  125.           V1.4  MAJOR UPDATE
  126.                 - fixed traversing directories
  127.                 - HandleIDCMP() uses Wait() now
  128.                 - FROM, TO paths are checked now
  129.                 - added batch mode.
  130.  
  131.           V1.4b MINOR UPDATE
  132.                 - bumped version
  133.                 - enhanced for more files
  134.                 
  135.           V1.4c MINOR UPDATE
  136.                 - bugfix file arrays
  137.                 - in CLI mode CTRL_C will abort
  138.                 - empty directories on backup are removed
  139.                                       
  140.  
  141.   2. Using it
  142.     ----------
  143.      2.1. Command line options
  144.          ----------------------
  145.           The program uses standard AmigaDOS command templates, so
  146.           typing 'FMirror ?' will list all the options available.
  147.  
  148.            Detail explanation of options:
  149.  
  150.              FROM/A       - the source path, a AmigaDOS file pattern may be
  151.                             given.
  152.                             
  153.                                 fe.   BACKUP:
  154.                                       BACKUP:Prefs/
  155.                                       BACKUP:S/#?.keyfile
  156.                                       
  157.                             As you can see, a volume needs no '/'. However, a 
  158.                             directory always needs a '/'.
  159.                             If a volume/directory is chosen, only that part will
  160.                             be checked, to include all subdirectories include the
  161.                             'ALL' switch.
  162.                             
  163.                                 fe.   FMirror BACKUP: TO SYS: ALL
  164.                                       FMirror BACKUP:data/ TO Work:data/ ALL
  165.                                                
  166.              TO/A         - the destination path.
  167.              
  168.                                 fe.  BOOT:
  169.                                      Work:Data/Pictures/
  170.                                      
  171.                             Same rules as above, a volume needs no '/'. A directory
  172.                             always needs an ending '/'. 
  173.                                      
  174.              NODELETE/S   - this does exactly what it says, when a file is not
  175.                             found it is normally deleted from the source path.
  176.                             Adding this parameter prevents this and the program will
  177.                             merely report the file.
  178.  
  179.              ALL/S        - include subdirectories.
  180.              
  181.              QUIET/S      - no output messages.
  182.  
  183.              GUI/S        - run in GUI mode, giving up to date statistics & speed !
  184.  
  185.              NOWAIT/S     - when in GUI mode, specifying this switch will close the
  186.                             window immediately after processing. Otherwise, the 
  187.                             window remains open until you click the close gadget.
  188.                             
  189.              CFG=CONFIG/K - this option invokes the batch mode, thus reading a config
  190.                             file for paths and options.  The paths used are the ones
  191.                             found for FBack (and in the right sequence).
  192.                             As you can see it is in fact the same config file as you
  193.                             used in FBack.
  194.  
  195.                             Syntax:
  196.                             
  197.                             ----------------- cut ------------------------
  198.  
  199.                                     [FBack]
  200.                                     NumberOfPaths = N
  201.  
  202.                                     [Paths]
  203.                                     SrcPath1 = fback source entry 1
  204.                                     DstPath1 = fback destination entry 1
  205.                                     ...
  206.                                     SrcPathN = fback source entry N
  207.                                     DstPathN = fback destination entry N
  208.  
  209.                                     [Options]
  210.                                     BOptions1 = fback options entry 1
  211.                                     MOptions1 = fmirror options entry 1
  212.                                     ...
  213.                                     BOptionsN = fback options entry N
  214.                                     MOptionsN = fmirror options entry N
  215.  
  216.                             ----------------- cut ------------------------
  217.  
  218.  
  219.                              The program opens up in GUI or CLI mode depending
  220.                              on the options in the 1st entry.
  221.  
  222.                              To start this mode use a commandline like:
  223.                              
  224.                                 fmirror "" "" cfg=myback.cfg
  225.                                 
  226.                                         or
  227.                                         
  228.                                 fmirror "" "" config=myback.cfg
  229.                                         
  230.  
  231.                              For an example see "MYBACK.CFG"
  232.                              
  233.                                 
  234.            The return code is either RETURN_OK (0) or RETURN_WARN (5) in all
  235.            other cases.
  236.            
  237.            When running in CLI mode the program can be aborted by pressing CTRL_C.
  238.            
  239.            For some examples look at next section "2.2. Examples".
  240.  
  241.  
  242.            =====================================================================
  243.            
  244.            WARNING ! THE SOURCE PATH (FROM) IS THE LOCATION OF THE BACKUP FILES,
  245.                      THE DESTINATION (TO) IS THE LOCATION OF THE ORIGINAL FILES.
  246.            
  247.            REMARK  ! BATCH MODE AUTOMATICALLY SWITCHES THIS FOR YOU, SO THERE IS
  248.                      NO NEED TO ADD EXTRA PATH SPECIFICATIONS.
  249.                      
  250.            =====================================================================          
  251.  
  252.  
  253.      2.2. Examples
  254.          ----------
  255.           This section lists some examples of usage.
  256.  
  257.           - Backup changed prefs files + maintain exact mirror:
  258.  
  259.                ; Startup-sequence
  260.                ...
  261.                FBack sys:prefs/env-archive/ to work:backup/prefs/ ALL GUI
  262.                FMirror work:backup/prefs/ to sys:prefs/env-archive/ ALL GUI
  263.                ...
  264.  
  265.           - Check consistency of backup:
  266.           
  267.               1>Fmirror backup:workbench/ sys: all nodelete
  268.               
  269.  
  270.   3. Appendix
  271.     ----------
  272.      3.1. Common problems
  273.          -----------------
  274.           Q: It doesn't find its source/destination files ?
  275.           
  276.           A: Enter the correct path: see section 2.1 (FROM,TO option).
  277.           
  278.           
  279.      3.2. Error messages
  280.          ----------------
  281.  
  282.           'Source/Destination not found'
  283.  
  284.              The entered path could not be located. Correct your paths !
  285.  
  286.           'File not found'
  287.  
  288.              The file you typed could not be found.
  289.  
  290.           AmigaDOS errors are in format :
  291.  
  292.              'FBack: nnn - message'
  293.  
  294.  
  295.      3.3. The future
  296.          ------------
  297.  
  298.           - ???
  299.  
  300.           Any suggestions from you are welcome !
  301.           
  302.   *********************************************************************
  303.